<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CheeseFlash: Cheese Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Cheese Reference Manual">
<link rel="up" href="libcheese-gtk.html" title="libcheese-gtk">
<link rel="prev" href="CheeseAvatarWidget.html" title="CheeseAvatarWidget">
<link rel="next" href="CheeseWidget.html" title="CheeseWidget">
<meta name="generator" content="GTK-Doc V1.29.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#CheeseFlash.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CheeseFlash.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#CheeseFlash.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#CheeseFlash.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libcheese-gtk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="CheeseAvatarWidget.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CheeseWidget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CheeseFlash"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CheeseFlash.top_of_page"></a>CheeseFlash</span></h2>
<p>CheeseFlash — Flash the screen, like a real camera flash</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CheeseFlash.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="CheeseFlash.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="returnvalue">CheeseFlash</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseFlash.html#cheese-flash-new" title="cheese_flash_new ()">cheese_flash_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CheeseFlash.html#cheese-flash-fire" title="cheese_flash_fire ()">cheese_flash_fire</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseFlash.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">GtkWidget</span> *</td>
<td class="property_name"><a class="link" href="CheeseFlash.html#CheeseFlash--parent" title="The “parent” property">parent</a></td>
<td class="property_flags">Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseFlash.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="CheeseFlash.html#CheeseFlash-struct" title="CheeseFlash">CheeseFlash</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseFlash.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> GtkWidget
            <span class="lineart">╰──</span> GtkContainer
                <span class="lineart">╰──</span> GtkBin
                    <span class="lineart">╰──</span> GtkWindow
                        <span class="lineart">╰──</span> CheeseFlash
</pre>
</div>
<div class="refsect1">
<a name="CheeseFlash.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
CheeseFlash implements
 AtkImplementorIface and  GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="CheeseFlash.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;cheese/cheese-flash.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="CheeseFlash.description"></a><h2>Description</h2>
<p><a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="type">CheeseFlash</span></a> is a window that you can create and invoke a method "flash" on
to temporarily flood the screen with white.</p>
</div>
<div class="refsect1">
<a name="CheeseFlash.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cheese-flash-new"></a><h3>cheese_flash_new ()</h3>
<pre class="programlisting"><a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="returnvalue">CheeseFlash</span></a> *
cheese_flash_new (<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>);</pre>
<p>Create a new <a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="type">CheeseFlash</span></a>, associated with the <em class="parameter"><code>parent</code></em>
 widget.</p>
<div class="refsect3">
<a name="cheese-flash-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>a parent <span class="type">GtkWidget</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cheese-flash-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="type">CheeseFlash</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-flash-fire"></a><h3>cheese_flash_fire ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cheese_flash_fire (<em class="parameter"><code><a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="type">CheeseFlash</span></a> *flash</code></em>);</pre>
<p>Fire the flash.</p>
<div class="refsect3">
<a name="cheese-flash-fire.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>flash</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="type">CheeseFlash</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="CheeseFlash.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CheeseFlash-struct"></a><h3>CheeseFlash</h3>
<pre class="programlisting">typedef struct _CheeseFlash CheeseFlash;</pre>
<p>Use the accessor functions below.</p>
</div>
</div>
<div class="refsect1">
<a name="CheeseFlash.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CheeseFlash--parent"></a><h3>The <code class="literal">“parent”</code> property</h3>
<pre class="programlisting">  “parent”                   <span class="type">GtkWidget</span> *</pre>
<p>Parent <span class="type">GtkWidget</span> for the <a class="link" href="CheeseFlash.html" title="CheeseFlash"><span class="type">CheeseFlash</span></a>. The flash will be fired on the
screen where the parent widget is shown.</p>
<p>Flags: Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29.1</div>
</body>
</html>